package com.amap.search.entity.vo;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;


/**
 * 请求参数更多的具体信息可参考：
 * https://lbs.amap.com/api/webservice/guide/api/search
 */
@ApiModel(description = "高德地图兴趣点搜索请求")
@Data
public class AmapPoiRequest {
    @ApiModelProperty("开发者密钥")
    private String key;

    @ApiModelProperty("查询关键字【规则：多个关键字用“|”分割如”美食|游乐园“】")
    private String keywords;

    @ApiModelProperty("查询POI类型， 该字段和keywords至少填一个")
    private String types;

    @ApiModelProperty("地区编号")
    private String city;

    @ApiModelProperty("仅返回指定城市数据, 默认false")
    private Boolean citylimit = true;

    @ApiModelProperty("是否按照层级展示子POI数据, 建议1")
    private String children = "1";

    @ApiModelProperty("每页展示数据，不超过25")
    private String offset = "10";

    @ApiModelProperty("当前页数，从1开始")
    private String page = "1";

    @ApiModelProperty("返回控制结果，建议all")
    private String extensions = "all";

}
